home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat3 / syslog.0 < prev    next >
Text File  |  1996-09-02  |  7KB  |  156 lines
  1.  
  2. SYSLOG(3)                  UNIX Programmer's Manual                  SYSLOG(3)
  3.  
  4. NNAAMMEE
  5.      ssyysslloogg, vvssyysslloogg, ooppeennlloogg, cclloosseelloogg, sseettllooggmmaasskk - control system log
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssyysslloogg..hh>>
  9.      ##iinncclluuddee <<vvaarraarrggss..hh>>
  10.  
  11.      _v_o_i_d
  12.      ssyysslloogg(_i_n_t _p_r_i_o_r_i_t_y, _c_o_n_s_t _c_h_a_r _*_m_e_s_s_a_g_e, _._._.)
  13.  
  14.      _v_o_i_d
  15.      vvssyysslloogg(_i_n_t _p_r_i_o_r_i_t_y, _c_o_n_s_t _c_h_a_r _*_m_e_s_s_a_g_e, _v_a___l_i_s_t _a_r_g_s)
  16.  
  17.      _v_o_i_d
  18.      ooppeennlloogg(_c_o_n_s_t _c_h_a_r _*_i_d_e_n_t, _i_n_t _l_o_g_o_p_t, _i_n_t _f_a_c_i_l_i_t_y)
  19.  
  20.      _v_o_i_d
  21.      cclloosseelloogg(_v_o_i_d)
  22.  
  23.      _i_n_t
  24.      sseettllooggmmaasskk(_i_n_t _m_a_s_k_p_r_i)
  25.  
  26. DDEESSCCRRIIPPTTIIOONN
  27.      The ssyysslloogg() function writes _m_e_s_s_a_g_e to the system message logger.  The
  28.      message is then written to the system console, log files, logged-in
  29.      users, or forwarded to other machines as appropriate. (See syslogd(8).)
  30.  
  31.      The message is identical to a printf(3) format string, except that `%m'
  32.      is replaced by the current error message. (As denoted by the global vari-
  33.      able _e_r_r_n_o; see strerror(3).)  A trailing newline is added if none is
  34.      present.
  35.  
  36.      The vvssyysslloogg() function is an alternate form in which the arguments have
  37.      already been captured using the variable-length argument facilities of
  38.      varargs(3).
  39.  
  40.      The message is tagged with _p_r_i_o_r_i_t_y. Priorities are encoded as a _f_a_c_i_l_i_t_y
  41.      and a _l_e_v_e_l. The facility describes the part of the system generating the
  42.      message.  The level is selected from the following _o_r_d_e_r_e_d (high to low)
  43.      list:
  44.  
  45.      LOG_EMERG     A panic condition.  This is normally broadcast to all
  46.                    users.
  47.  
  48.      LOG_ALERT     A condition that should be corrected immediately, such as a
  49.                    corrupted system database.
  50.  
  51.      LOG_CRIT      Critical conditions, e.g., hard device errors.
  52.  
  53.      LOG_ERR       Errors.
  54.  
  55.      LOG_WARNING   Warning messages.
  56.  
  57.      LOG_NOTICE    Conditions that are not error conditions, but should possi-
  58.                    bly be handled specially.
  59.  
  60.      LOG_INFO      Informational messages.
  61.  
  62.      LOG_DEBUG     Messages that contain information normally of use only when
  63.                    debugging a program.
  64.  
  65.  
  66.      The ooppeennlloogg() function provides for more specialized processing of the
  67.      messages sent by ssyysslloogg() and vvssyysslloogg().  The parameter _i_d_e_n_t is a string
  68.      that will be prepended to every message.  The _l_o_g_o_p_t argument is a bit
  69.      field specifying logging options, which is formed by OR'ing one or more
  70.      of the following values:
  71.  
  72.      LOG_CONS      If ssyysslloogg() cannot pass the message to syslogd it will at-
  73.                    tempt to write the message to the console
  74.                    (``_/_d_e_v_/_c_o_n_s_o_l_e_.'')
  75.  
  76.      LOG_NDELAY    Open the connection to syslogd immediately.  Normally the
  77.                    open is delayed until the first message is logged.  Useful
  78.                    for programs that need to manage the order in which file
  79.                    descriptors are allocated.
  80.  
  81.      LOG_PERROR    Write the message to standard error output as well to the
  82.                    system log.
  83.  
  84.      LOG_PID       Log the process id with each message: useful for identify-
  85.                    ing instantiations of daemons.
  86.  
  87.      The _f_a_c_i_l_i_t_y parameter encodes a default facility to be assigned to all
  88.      messages that do not have an explicit facility encoded:
  89.  
  90.      LOG_AUTH      The authorization system: login(1),  su(1),  getty(8),
  91.                    etc.
  92.  
  93.      LOG_AUTHPRIV  The same as LOG_AUTH, but logged to a file readable only by
  94.                    selected individuals.
  95.  
  96.      LOG_CRON      The cron daemon: cron(8).
  97.  
  98.      LOG_DAEMON    System daemons, such as routed(8),  that are not provided
  99.                    for explicitly by other facilities.
  100.  
  101.      LOG_FTP       The file transfer protocol daemon: ftpd(8).
  102.  
  103.      LOG_KERN      Messages generated by the kernel.  These cannot be generat-
  104.                    ed by any user processes.
  105.  
  106.      LOG_LPR       The line printer spooling system: lpr(1),  lpc(8),  lpd(8),
  107.                     etc.
  108.  
  109.      LOG_MAIL      The mail system.
  110.  
  111.      LOG_NEWS      The network news system.
  112.  
  113.      LOG_SYSLOG    Messages generated internally by syslogd(8).
  114.  
  115.      LOG_USER      Messages generated by random user processes.  This is the
  116.                    default facility identifier if none is specified.
  117.  
  118.      LOG_UUCP      The uucp system.
  119.  
  120.      LOG_LOCAL0    Reserved for local use.  Similarly for LOG_LOCAL1 through
  121.                    LOG_LOCAL7.
  122.  
  123.      The cclloosseelloogg() function can be used to close the log file.
  124.  
  125.      The sseettllooggmmaasskk() function sets the log priority mask to _m_a_s_k_p_r_i and re-
  126.      turns the previous mask.  Calls to ssyysslloogg() with a priority not set in
  127.      _m_a_s_k_p_r_i are rejected.  The mask for an individual priority _p_r_i is calcu-
  128.      lated by the macro LLOOGG__MMAASSKK(_p_r_i); the mask for all priorities up to and
  129.      including _t_o_p_p_r_i is given by the macro LLOOGG__UUPPTTOO(_t_o_p_p_r_i);. The default al-
  130.      lows all priorities to be logged.
  131.  
  132. RREETTUURRNN VVAALLUUEESS
  133.      The routines cclloosseelloogg(), ooppeennlloogg(), ssyysslloogg() and vvssyysslloogg() return no val-
  134.      ue.
  135.  
  136.      The routine sseettllooggmmaasskk() always returns the previous log mask level.
  137.  
  138. EEXXAAMMPPLLEESS
  139.            syslog(LOG_ALERT, "who: internal error 23");
  140.  
  141.            openlog("ftpd", LOG_PID | LOG_NDELAY, LOG_FTP);
  142.  
  143.            setlogmask(LOG_UPTO(LOG_ERR));
  144.  
  145.            syslog(LOG_INFO, "Connection from host %d", CallingHost);
  146.  
  147.            syslog(LOG_INFO|LOG_LOCAL2, "foobar error: %m");
  148.  
  149. SSEEEE AALLSSOO
  150.      logger(1),  syslogd(8)
  151.  
  152. HHIISSTTOORRYY
  153.      These functions appeared in 4.2BSD.
  154.  
  155. 4.2 Berkeley Distribution        June 4, 1993                                3
  156.